﻿using System;

namespace BizElements.Generator
{
    /// <summary>Enumerates template variable and settings names which generally affect the behavior of all ICodeGenerator implementations.</summary>
    static class SpecialVariable
    {
        /// <summary>Specifies taht generator should append the given value at the end of the file name.</summary>
        public const string FileNameSuffix = "FileNameSuffix";

        /// <summary>Specifies that generator should use the given value as file extension.</summary>
        public const string FileExtension = "FileExtension";

        /// <summary>Specifies that generator should create a sub-directory that will contains items generated by template.
        /// May be parametrized, i.e. all {0} occurrences should be replaced by value stored in <b>SolutionNamespace</b> variable.</summary>
        public const string OutputSubdirectory = "OutputSubdirectory";

        /// <summary>Specifies that generator should write code for all generated items in to the file with the given name.
        /// May be parametrized, i.e. all {0} occurrences should be replaced by value stored in <b>SolutionNamespace</b> variable.</summary>
        public const string SingleFile = "SingleFile";

        /// <summary>Solution namespace - replaces all {0} occurrences in <b>OutputSubdirectory</b> and <b>SingleFile</b> variables.</summary>
        public const string SolutionNamespace = "SolutionNamespace";
    }
}
